<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensorshell.usermap;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.HashMap;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Properties;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.Set;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    import org.hackystat.sensorshell.SensorShell;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.hackystat.sensorshell.SensorShellProperties;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.sensorshell.usermap.UserMap.UserMapKey;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * Allows for lazy instantiation of SensorShells for user tool accounts. This class abstracts the<a name="line.13"></a>
<FONT color="green">014</FONT>     * use of the UserMap class so that sensors for applicable tool sensors won't have to manage it.<a name="line.14"></a>
<FONT color="green">015</FONT>     * &lt;p&gt;<a name="line.15"></a>
<FONT color="green">016</FONT>     * The &lt;code&gt;SensorShellMap&lt;/code&gt; is meant to only derive SensorShells for a specific tool.<a name="line.16"></a>
<FONT color="green">017</FONT>     * Queries for SensorShells are done by giving an account name to the &lt;code&gt;getUserShell&lt;/code&gt;<a name="line.17"></a>
<FONT color="green">018</FONT>     * method. This account name must be specific to the tool of the &lt;code&gt;SensorShellMap&lt;/code&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * instance.<a name="line.19"></a>
<FONT color="green">020</FONT>     * &lt;p&gt;<a name="line.20"></a>
<FONT color="green">021</FONT>     * Note that the "tool" name is used in a case-insensitive fashion.<a name="line.21"></a>
<FONT color="green">022</FONT>     * <a name="line.22"></a>
<FONT color="green">023</FONT>     * @author Burt Leung, Julie Ann Sakuda (v8 port)<a name="line.23"></a>
<FONT color="green">024</FONT>     */<a name="line.24"></a>
<FONT color="green">025</FONT>    public class SensorShellMap {<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>      /** The tool that this SensorShellMap will return SensorShells for. */<a name="line.27"></a>
<FONT color="green">028</FONT>      private String tool;<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>      /** Mapping of Tool specific user accounts to their Hackystat information. */<a name="line.30"></a>
<FONT color="green">031</FONT>      private UserMap userMap;<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>      /** Map of Tool specific tool accounts to their SensorShells. */<a name="line.33"></a>
<FONT color="green">034</FONT>      private HashMap&lt;String, SensorShell&gt; toolAccountsToShells = new HashMap&lt;String, SensorShell&gt;();<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>      /**<a name="line.36"></a>
<FONT color="green">037</FONT>       * Instantiate this class which initializes the UserMap used to get SensorShells for users and<a name="line.37"></a>
<FONT color="green">038</FONT>       * also sets the Hackystat host for the SensorShells.<a name="line.38"></a>
<FONT color="green">039</FONT>       * <a name="line.39"></a>
<FONT color="green">040</FONT>       * @param tool The specific tool that this SensorShellMap will provide SensorShells for.<a name="line.40"></a>
<FONT color="green">041</FONT>       * @throws SensorShellMapException Indicates that the usermaps.xml file is not found.<a name="line.41"></a>
<FONT color="green">042</FONT>       */<a name="line.42"></a>
<FONT color="green">043</FONT>      public SensorShellMap(String tool) throws SensorShellMapException {<a name="line.43"></a>
<FONT color="green">044</FONT>        // Ensure valid argument<a name="line.44"></a>
<FONT color="green">045</FONT>        if (tool == null || tool.length() == 0) {<a name="line.45"></a>
<FONT color="green">046</FONT>          throw new SensorShellMapException("Error: tool is null or empty string.");<a name="line.46"></a>
<FONT color="green">047</FONT>        }<a name="line.47"></a>
<FONT color="green">048</FONT>        this.tool = tool.trim();<a name="line.48"></a>
<FONT color="green">049</FONT>        this.userMap = new UserMap();<a name="line.49"></a>
<FONT color="green">050</FONT>      }<a name="line.50"></a>
<FONT color="green">051</FONT>    <a name="line.51"></a>
<FONT color="green">052</FONT>      /**<a name="line.52"></a>
<FONT color="green">053</FONT>       * A package private constructor meant to be used only by Junit test cases.<a name="line.53"></a>
<FONT color="green">054</FONT>       * <a name="line.54"></a>
<FONT color="green">055</FONT>       * @param tool The specific tool that this SensorShellMap will provide SensorShells for.<a name="line.55"></a>
<FONT color="green">056</FONT>       * @param userMapFile The UserMap.xml file.<a name="line.56"></a>
<FONT color="green">057</FONT>       * @throws SensorShellMapException Indicates that the UserMap.xml file is not found.<a name="line.57"></a>
<FONT color="green">058</FONT>       */<a name="line.58"></a>
<FONT color="green">059</FONT>      public SensorShellMap(String tool, File userMapFile)<a name="line.59"></a>
<FONT color="green">060</FONT>          throws SensorShellMapException {<a name="line.60"></a>
<FONT color="green">061</FONT>        this.tool = tool;<a name="line.61"></a>
<FONT color="green">062</FONT>        this.userMap = new UserMap(userMapFile);<a name="line.62"></a>
<FONT color="green">063</FONT>      }<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>      /**<a name="line.65"></a>
<FONT color="green">066</FONT>       * Returns true if toolAccount is known so that a corresponding SensorShell can be retrieved.<a name="line.66"></a>
<FONT color="green">067</FONT>       * <a name="line.67"></a>
<FONT color="green">068</FONT>       * @param toolAccount The toolAccount for the tool in this instance, such as "johnson".<a name="line.68"></a>
<FONT color="green">069</FONT>       * @return True if toolAccount is known, otherwise false.<a name="line.69"></a>
<FONT color="green">070</FONT>       */<a name="line.70"></a>
<FONT color="green">071</FONT>      public boolean hasUserShell(String toolAccount) {<a name="line.71"></a>
<FONT color="green">072</FONT>        if (toolAccount == null || toolAccount.length() == 0) {<a name="line.72"></a>
<FONT color="green">073</FONT>          return false;<a name="line.73"></a>
<FONT color="green">074</FONT>        }<a name="line.74"></a>
<FONT color="green">075</FONT>        else {<a name="line.75"></a>
<FONT color="green">076</FONT>          return this.userMap.hasUser(this.tool, toolAccount.trim());<a name="line.76"></a>
<FONT color="green">077</FONT>        }<a name="line.77"></a>
<FONT color="green">078</FONT>      }<a name="line.78"></a>
<FONT color="green">079</FONT>      <a name="line.79"></a>
<FONT color="green">080</FONT>      /**<a name="line.80"></a>
<FONT color="green">081</FONT>       * Returns the set of tool account names associated with this tool in the usermaps file.<a name="line.81"></a>
<FONT color="green">082</FONT>       * @param tool The tool of interest.<a name="line.82"></a>
<FONT color="green">083</FONT>       * @return The known tool account names for this tool.<a name="line.83"></a>
<FONT color="green">084</FONT>       */<a name="line.84"></a>
<FONT color="green">085</FONT>      public Set&lt;String&gt; getToolAccounts(String tool) {<a name="line.85"></a>
<FONT color="green">086</FONT>        return this.userMap.getToolAccounts(tool);<a name="line.86"></a>
<FONT color="green">087</FONT>      }<a name="line.87"></a>
<FONT color="green">088</FONT>      <a name="line.88"></a>
<FONT color="green">089</FONT>      /**<a name="line.89"></a>
<FONT color="green">090</FONT>       * Returns the UserMap file name associated with this SensorShellMap.<a name="line.90"></a>
<FONT color="green">091</FONT>       * This file may or may not exist.<a name="line.91"></a>
<FONT color="green">092</FONT>       * @return The usermap file name associated with this SensorShellMap. <a name="line.92"></a>
<FONT color="green">093</FONT>       */<a name="line.93"></a>
<FONT color="green">094</FONT>      public String getUserMapFile() {<a name="line.94"></a>
<FONT color="green">095</FONT>        return this.userMap.getUserMapFile();<a name="line.95"></a>
<FONT color="green">096</FONT>      }<a name="line.96"></a>
<FONT color="green">097</FONT>      <a name="line.97"></a>
<FONT color="green">098</FONT>      /**<a name="line.98"></a>
<FONT color="green">099</FONT>       * Validates the hackystat user, password, and sensorbase associated with tool. <a name="line.99"></a>
<FONT color="green">100</FONT>       * Throws an exception if the sensorbase cannot be contacted and/or if the user/password<a name="line.100"></a>
<FONT color="green">101</FONT>       * combination is not valid for the associated sensorbase. <a name="line.101"></a>
<FONT color="green">102</FONT>       * @param tool The tool of interest. <a name="line.102"></a>
<FONT color="green">103</FONT>       * @throws SensorShellMapException Thrown if user map info cannot be validated. <a name="line.103"></a>
<FONT color="green">104</FONT>       */<a name="line.104"></a>
<FONT color="green">105</FONT>      public void validateHackystatInfo(String tool) throws SensorShellMapException {<a name="line.105"></a>
<FONT color="green">106</FONT>        this.userMap.validateHackystatUsers(tool);<a name="line.106"></a>
<FONT color="green">107</FONT>      }<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>      /**<a name="line.109"></a>
<FONT color="green">110</FONT>       * Gets the SensorShell instance for a Hackystat user with an account for the given tool. Assumes<a name="line.110"></a>
<FONT color="green">111</FONT>       * that toolAccount is known and will map to a userKey; use hasUserShell() to check whether this<a name="line.111"></a>
<FONT color="green">112</FONT>       * is true before calling this method. Instantiates the SensorShell instance if it is not yet<a name="line.112"></a>
<FONT color="green">113</FONT>       * available.<a name="line.113"></a>
<FONT color="green">114</FONT>       * <a name="line.114"></a>
<FONT color="green">115</FONT>       * @param toolAccount The name of the account for the given tool. This is not the same as the<a name="line.115"></a>
<FONT color="green">116</FONT>       *          Hackystat account name although it may be the same.<a name="line.116"></a>
<FONT color="green">117</FONT>       * @return The SensorShell instance for the specific Hackystat user.<a name="line.117"></a>
<FONT color="green">118</FONT>       * @throws SensorShellMapException When the user account and/or tool is undefined.<a name="line.118"></a>
<FONT color="green">119</FONT>       */<a name="line.119"></a>
<FONT color="green">120</FONT>      public SensorShell getUserShell(String toolAccount) throws SensorShellMapException {<a name="line.120"></a>
<FONT color="green">121</FONT>       return getUserShell(toolAccount, null);<a name="line.121"></a>
<FONT color="green">122</FONT>      }<a name="line.122"></a>
<FONT color="green">123</FONT>      <a name="line.123"></a>
<FONT color="green">124</FONT>      /**<a name="line.124"></a>
<FONT color="green">125</FONT>       * Gets the SensorShell instance for a Hackystat user with an account for the given tool. Assumes<a name="line.125"></a>
<FONT color="green">126</FONT>       * that toolAccount is known and will map to a userKey; use hasUserShell() to check whether this<a name="line.126"></a>
<FONT color="green">127</FONT>       * is true before calling this method. Instantiates the SensorShell instance if it is not yet<a name="line.127"></a>
<FONT color="green">128</FONT>       * available.<a name="line.128"></a>
<FONT color="green">129</FONT>       * <a name="line.129"></a>
<FONT color="green">130</FONT>       * @param toolAccount The name of the account for the given tool. This is not the same as the<a name="line.130"></a>
<FONT color="green">131</FONT>       *          Hackystat account name although it may be the same.<a name="line.131"></a>
<FONT color="green">132</FONT>       * @param properties A properties instance holding SensorShell properties to be used to <a name="line.132"></a>
<FONT color="green">133</FONT>       * initialize the underlying SensorShell if it requires instantiation. If null, then no <a name="line.133"></a>
<FONT color="green">134</FONT>       * additional properties are required.          <a name="line.134"></a>
<FONT color="green">135</FONT>       * @return The SensorShell instance for the specific Hackystat user.<a name="line.135"></a>
<FONT color="green">136</FONT>       * @throws SensorShellMapException When the user account and/or tool is undefined.<a name="line.136"></a>
<FONT color="green">137</FONT>       */<a name="line.137"></a>
<FONT color="green">138</FONT>      public SensorShell getUserShell(String toolAccount, Properties properties) <a name="line.138"></a>
<FONT color="green">139</FONT>      throws SensorShellMapException {<a name="line.139"></a>
<FONT color="green">140</FONT>        // Check argument that it is valid<a name="line.140"></a>
<FONT color="green">141</FONT>        if (toolAccount == null || toolAccount.length() == 0) {<a name="line.141"></a>
<FONT color="green">142</FONT>          throw new SensorShellMapException("Error: toolAccount is null or the empty string.");<a name="line.142"></a>
<FONT color="green">143</FONT>        }<a name="line.143"></a>
<FONT color="green">144</FONT>        String trimmedToolAccount = toolAccount.trim();<a name="line.144"></a>
<FONT color="green">145</FONT>        try {<a name="line.145"></a>
<FONT color="green">146</FONT>          String user = this.userMap.get(this.tool, trimmedToolAccount, UserMapKey.USER);<a name="line.146"></a>
<FONT color="green">147</FONT>          String password = this.userMap.get(this.tool, trimmedToolAccount, UserMapKey.PASSWORD);<a name="line.147"></a>
<FONT color="green">148</FONT>          String host = this.userMap.get(this.tool, trimmedToolAccount, UserMapKey.SENSORBASE);<a name="line.148"></a>
<FONT color="green">149</FONT>          // If we haven't instantiated this shell yet, then do it now.<a name="line.149"></a>
<FONT color="green">150</FONT>          if (this.toolAccountsToShells.get(toolAccount) == null) {<a name="line.150"></a>
<FONT color="green">151</FONT>            // First, build the SensorShellProperties instance. <a name="line.151"></a>
<FONT color="green">152</FONT>            // If properties is null, then call the three arg constructor. otherwise pass them in.<a name="line.152"></a>
<FONT color="green">153</FONT>            // Note: properties do not override user preferences as set in sensorshell.properties.<a name="line.153"></a>
<FONT color="green">154</FONT>            SensorShellProperties sensorProps = (properties == null) ? <a name="line.154"></a>
<FONT color="green">155</FONT>                new SensorShellProperties(host, user, password) :<a name="line.155"></a>
<FONT color="green">156</FONT>                  new SensorShellProperties(host, user, password, properties, false) ;<a name="line.156"></a>
<FONT color="green">157</FONT>            // Now, instantiate the non-interactive SensorShell.<a name="line.157"></a>
<FONT color="green">158</FONT>            SensorShell userShell = new SensorShell(sensorProps, false, this.tool + "-" + user);<a name="line.158"></a>
<FONT color="green">159</FONT>            this.toolAccountsToShells.put(trimmedToolAccount, userShell);<a name="line.159"></a>
<FONT color="green">160</FONT>          }<a name="line.160"></a>
<FONT color="green">161</FONT>          // Now return the SensorShell.<a name="line.161"></a>
<FONT color="green">162</FONT>          return this.toolAccountsToShells.get(trimmedToolAccount);<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>        catch (Exception e) {<a name="line.164"></a>
<FONT color="green">165</FONT>          throw new SensorShellMapException("Error getting SensorShell for " + toolAccount, e);<a name="line.165"></a>
<FONT color="green">166</FONT>        }<a name="line.166"></a>
<FONT color="green">167</FONT>      }<a name="line.167"></a>
<FONT color="green">168</FONT>    }<a name="line.168"></a>




























































</PRE>
</BODY>
</HTML>
